<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="elementtree-xmltreebuilder-objects.html" />
<link rel="prev" href="elementtree-qname-objects.html" />
<link rel="parent" href="module-xml.etree.ElementTree.html" />
<link rel="next" href="elementtree-xmltreebuilder-objects.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>8.13.4 TreeBuilder Objects</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.13.3 qname Objects"
  href="elementtree-qname-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="8.13 xml.etree.ElementTree  "
  href="module-xml.etree.ElementTree.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="8.13.5 xmltreebuilder Objects"
  href="elementtree-xmltreebuilder-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="elementtree-qname-objects.html">8.13.3 QName Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xml.etree.ElementTree.html">8.13 xml.etree.ElementTree  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="elementtree-xmltreebuilder-objects.html">8.13.5 XMLTreeBuilder Objects</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION00101340000000000000000"></a><a name="elementtree-treebuilder-objects"></a>
<br>
8.13.4 TreeBuilder Objects
</h2>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-1996' xml:id='l2h-1996' class="class">TreeBuilder</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>element_factory</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Generic element structure builder.  This builder converts a sequence
of start, data, and end method calls to a well-formed element structure.
You can use this class to build an element structure using a custom XML
parser, or a parser for some other XML-like format.
The <var>element_factory</var> is called to create new Element instances when
given.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1997' xml:id='l2h-1997' class="method">close</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Flushes the parser buffers, and returns the toplevel documen
element.

<p>
<dl><dt><b><tt>Returns:</tt></b></dt>
<dd>
An Element instance.
</dd></dl>
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1998' xml:id='l2h-1998' class="method">data</tt></b>(</nobr></td>
  <td><var>data</var>)</td></tr></table></dt>
<dd>
Adds text to the current element.
<var>data</var> is a string.  This should be either an 8-bit string
containing ASCII text, or a Unicode string.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1999' xml:id='l2h-1999' class="method">end</tt></b>(</nobr></td>
  <td><var>tag</var>)</td></tr></table></dt>
<dd>
Closes the current element.
<var>tag</var> is the element name.

<p>
<dl><dt><b><tt>Returns:</tt></b></dt>
<dd>
The closed element.
</dd></dl>
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2000' xml:id='l2h-2000' class="method">start</tt></b>(</nobr></td>
  <td><var>tag, attrs</var>)</td></tr></table></dt>
<dd>
Opens a new element.
<var>tag</var> is the element name.
<var>attrs</var> is a dictionary containing element attributes.

<p>
<dl><dt><b><tt>Returns:</tt></b></dt>
<dd>
The opened element.
</dd></dl>
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.13.3 qname Objects"
  href="elementtree-qname-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="8.13 xml.etree.ElementTree  "
  href="module-xml.etree.ElementTree.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="8.13.5 xmltreebuilder Objects"
  href="elementtree-xmltreebuilder-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="elementtree-qname-objects.html">8.13.3 QName Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xml.etree.ElementTree.html">8.13 xml.etree.ElementTree  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="elementtree-xmltreebuilder-objects.html">8.13.5 XMLTreeBuilder Objects</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
